/*
 * Copyright 2007-2008  Lukasz Laszko lukaszlaszko@gmail.com
 * 
 * Permission to use, copy, modify, and distribute this software
 * and its documentation for any purpose and without fee is hereby
 * granted, provided that the above copyright notice appear in all
 * copies and that both that the copyright notice and this
 * permission notice and warranty disclaimer appear in supporting
 * documentation, and that the name of the author not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * 
 * The author disclaim all warranties with regard to this
 * software, including all implied warranties of merchantability
 * and fitness.  In no event shall the author be liable for any
 * special, indirect or consequential damages or any damages
 * whatsoever resulting from loss of use, data or profits, whether
 * in an action of contract, negligence or other tortious action,
 * arising out of or in connection with the use or performance of
 * this software. 
 */
package org.pg.biomedics.asr.mpeg7;

import org.simpleframework.xml.Root;
import org.simpleframework.xml.Element;

/**
 * A SpokenContentHeader contains some metadata information that can be 
 * shared by different lattices, such as the recognition lexicons of the 
 * ASR systems used for extraction or the speaker identity.
 * It consists of five types of metadata:
 * • WordLexicon: a list of words. A header may contain several word lexicons.
 * • PhoneLexicon: a list of phones. A header may contain several phone lexicons.
 * • ConfusionInfo: a data structure enclosing some phone confusion information.
 *   Although separate, the confusion information must map onto the phone lexicon
 *   with which it is associated via the SpeakerInfo descriptor.
 * • DescriptionMetadata: information about the extraction process used to generate
 *   the lattices. In particular, this data structure can store the name and settings
 *   of the speech recognition engine used for lattice extraction.
 * • SpeakerInfo: information about the persons speaking in the original audio
 *   signals, along with other information about their associated lattices.
 * 
 * @author Lukasz Laszko
 */
@Root(name="Header")
public class SpokenContentHeader 
{
    // <editor-fold desc="Fields">
    
    private WordLexicon wordLexicon;
    private PhoneLexicon phoneLexicon;
    private ConfusionInfo confusionInfo;
    private DescriptionMetadata descriptionMetadata;
    private SpeakerInfo speakerInfo;    
    
    // </editor-fold>
    
    // <editor-fold desc="Properties">
      
    /**
     * Gets the current word lexicon
     * @return
     */
    @Element(name="WordLexicon")
    public WordLexicon getWordLexicon()
    {
        return wordLexicon;
    }

    /**
     * Sets a word lexicon
     * @param wordLexicon
     */
    @Element(name="WordLexicon")
    public void setWordLexicon(WordLexicon wordLexicon)
    {
        this.wordLexicon = wordLexicon;
    }

    public PhoneLexicon getPhoneLexicon()
    {
        return phoneLexicon;
    }

    public void setPhoneLexicon(PhoneLexicon phoneLexicon)
    {
        this.phoneLexicon = phoneLexicon;
    }

    public ConfusionInfo getConfusionInfo()
    {
        return confusionInfo;
    }

    public void setConfusionInfo(ConfusionInfo confusionInfo)
    {
        this.confusionInfo = confusionInfo;
    }

    public DescriptionMetadata getDescriptionMetadata()
    {
        return descriptionMetadata;
    }

    public void setDescriptionMetadata(DescriptionMetadata descriptionMetadata)
    {
        this.descriptionMetadata = descriptionMetadata;
    }

    public SpeakerInfo getSpeakerInfo()
    {
        return speakerInfo;
    }

    public void setSpeakerInfo(SpeakerInfo speakerInfo)
    {
        this.speakerInfo = speakerInfo;
    }
    
    // </editor-fold>
}
